Node / meshtastic / Meshtastic-Android / files / app / src / main / java / com / geeksville / mesh / model / Channel.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2025 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787com.geeksville.mesh.model

Tff7b72import T7ee787com.geeksville.mesh.ChannelProtos

Tff7b72import T7ee787com.geeksville.mesh.ConfigProtos.Config.LoRaConfig.ModemPreset

Tff7b72import T7ee787com.geeksville.mesh.ConfigKt.loRaConfig

Tff7b72import T7ee787com.geeksville.mesh.ConfigProtos

Tff7b72import T7ee787com.geeksville.mesh.channelSettings

Tff7b72import T7ee787com.google.protobuf.ByteString

Tff7b72import T7ee787java.security.SecureRandom

T8b949e/** Utility function to make it easy to declare byte arrays - FIXME move someplace better */

Tff7b72fun Td2a8ffbyteArrayOfIntsTb4b4b4(Tff7b72vararg Te6edf3intsTb4b4b4: Tffa657IntTb4b4b4) Tff7b72= Te6edf3ByteArrayTb4b4b4(Te6edf3intsTb4b4b4.Te6edf3sizeTb4b4b4) Tb4b4b4{ Te6edf3pos Tff7b72-Tff7b72> Te6edf3intsTff7b72[Te6edf3posTff7b72]Tb4b4b4.Te6edf3toByteTb4b4b4(Tb4b4b4) Tb4b4b4}

Tff7b72fun Td2a8ffxorHashTb4b4b4(Te6edf3bTb4b4b4: Te6edf3ByteArrayTb4b4b4) Tff7b72= Te6edf3bTb4b4b4.Te6edf3foldTb4b4b4(T79c0ff0Tb4b4b4) Tb4b4b4{ Te6edf3accTb4b4b4, Te6edf3x Tff7b72-Tff7b72> Te6edf3acc Te6edf3xor Tb4b4b4(Te6edf3xTb4b4b4.Te6edf3toIntTb4b4b4(Tb4b4b4) Te6edf3and T79c0ff0Te6edf3xffTb4b4b4) Tb4b4b4}

Tff7b72data Tff7b72class T56d364ChannelTb4b4b4(

Tff7b72val Te6edf3settingsTb4b4b4: Te6edf3ChannelProtosTb4b4b4.Te6edf3ChannelSettings Tff7b72= Te6edf3defaultTb4b4b4.Te6edf3settingsTb4b4b4,

Tff7b72val Te6edf3loraConfigTb4b4b4: Te6edf3ConfigProtosTb4b4b4.Te6edf3ConfigTb4b4b4.Te6edf3LoRaConfig Tff7b72= Te6edf3defaultTb4b4b4.Te6edf3loraConfigTb4b4b4,

Tb4b4b4) Tb4b4b4{

Tff7b72companion Tff7b72object Tb4b4b4{

T8b949e// These bytes must match the well known and not secret bytes used the default channel AES128 key device code

Tff7b72private Tff7b72val Te6edf3channelDefaultKey Tff7b72= Te6edf3byteArrayOfIntsTb4b4b4(

T79c0ff0Te6edf3xd4Tb4b4b4, T79c0ff0Te6edf3xf1Tb4b4b4, T79c0ff0Te6edf3xbbTb4b4b4, T79c0ff0Te6edf3x3aTb4b4b4, T79c0ff0Te6edf3x20Tb4b4b4, T79c0ff0Te6edf3x29Tb4b4b4, T79c0ff0Te6edf3x07Tb4b4b4, T79c0ff0Te6edf3x59Tb4b4b4,

T79c0ff0Te6edf3xf0Tb4b4b4, T79c0ff0Te6edf3xbcTb4b4b4, T79c0ff0Te6edf3xffTb4b4b4, T79c0ff0Te6edf3xabTb4b4b4, T79c0ff0Te6edf3xcfTb4b4b4, T79c0ff0Te6edf3x4eTb4b4b4, T79c0ff0Te6edf3x69Tb4b4b4, T79c0ff0Te6edf3x01

Tb4b4b4)

Tff7b72private Tff7b72val Te6edf3cleartextPSK Tff7b72= Te6edf3ByteStringTb4b4b4.Te6edf3EMPTY

Tff7b72private Tff7b72val Te6edf3defaultPSK Tff7b72=

Te6edf3byteArrayOfIntsTb4b4b4(T79c0ff1Tb4b4b4) T8b949e// a shortstring code to indicate we need our default PSK

T8b949e// The default channel that devices ship with

Tff7b72val Te6edf3default Tff7b72= Te6edf3ChannelTb4b4b4(

Te6edf3channelSettings Tb4b4b4{ Te6edf3psk Tff7b72= Te6edf3ByteStringTb4b4b4.Te6edf3copyFromTb4b4b4(Te6edf3defaultPSKTb4b4b4) Tb4b4b4}Tb4b4b4,

T8b949e// references: NodeDB::installDefaultConfig / Channels::initDefaultChannel

Te6edf3loRaConfig Tb4b4b4{

Te6edf3usePreset Tff7b72= Tff7b72true

Te6edf3modemPreset Tff7b72= Te6edf3ModemPresetTb4b4b4.Te6edf3LONG_FAST

Te6edf3hopLimit Tff7b72= T79c0ff3

Te6edf3txEnabled Tff7b72= Tff7b72true

Tb4b4b4}

Tb4b4b4)

Tff7b72fun Td2a8ffgetRandomKeyTb4b4b4(Te6edf3sizeTb4b4b4: Tffa657Int Tff7b72= T79c0ff3T79c0ff2Tb4b4b4)Tb4b4b4: Te6edf3ByteString Tb4b4b4{

Tff7b72val Te6edf3bytes Tff7b72= Te6edf3ByteArrayTb4b4b4(Te6edf3sizeTb4b4b4)

Tff7b72val Te6edf3random Tff7b72= Te6edf3SecureRandomTb4b4b4(Tb4b4b4)

Te6edf3randomTb4b4b4.Te6edf3nextBytesTb4b4b4(Te6edf3bytesTb4b4b4)

Tff7b72return Te6edf3ByteStringTb4b4b4.Te6edf3copyFromTb4b4b4(Te6edf3bytesTb4b4b4)

Tb4b4b4}

Tb4b4b4}

T8b949e// Return the name of our channel as a human readable string. If empty string, assume "Default" per mesh.proto spec

Tff7b72val Te6edf3nameTb4b4b4: Tffa657String

Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3settingsTb4b4b4.Te6edf3nameTb4b4b4.Te6edf3ifEmpty Tb4b4b4{

T8b949e// We have a new style 'empty' channel name. Use the same logic from the device to convert that to a human readable name

Tff7b72if Tb4b4b4(Te6edf3loraConfigTb4b4b4.Te6edf3usePresetTb4b4b4) Tff7b72when Tb4b4b4(Te6edf3loraConfigTb4b4b4.Te6edf3modemPresetTb4b4b4) Tb4b4b4{

Te6edf3ModemPresetTb4b4b4.Te6edf3SHORT_TURBO Tff7b72-Tff7b72> Ta5d6ff"Ta5d6ffShortTurboTa5d6ff"

Te6edf3ModemPresetTb4b4b4.Te6edf3SHORT_FAST Tff7b72-Tff7b72> Ta5d6ff"Ta5d6ffShortFastTa5d6ff"

Te6edf3ModemPresetTb4b4b4.Te6edf3SHORT_SLOW Tff7b72-Tff7b72> Ta5d6ff"Ta5d6ffShortSlowTa5d6ff"

Te6edf3ModemPresetTb4b4b4.Te6edf3MEDIUM_FAST Tff7b72-Tff7b72> Ta5d6ff"Ta5d6ffMediumFastTa5d6ff"

Te6edf3ModemPresetTb4b4b4.Te6edf3MEDIUM_SLOW Tff7b72-Tff7b72> Ta5d6ff"Ta5d6ffMediumSlowTa5d6ff"

Te6edf3ModemPresetTb4b4b4.Te6edf3LONG_FAST Tff7b72-Tff7b72> Ta5d6ff"Ta5d6ffLongFastTa5d6ff"

Te6edf3ModemPresetTb4b4b4.Te6edf3LONG_SLOW Tff7b72-Tff7b72> Ta5d6ff"Ta5d6ffLongSlowTa5d6ff"

Te6edf3ModemPresetTb4b4b4.Te6edf3LONG_MODERATE Tff7b72-Tff7b72> Ta5d6ff"Ta5d6ffLongModTa5d6ff"

Te6edf3ModemPresetTb4b4b4.Te6edf3VERY_LONG_SLOW Tff7b72-Tff7b72> Ta5d6ff"Ta5d6ffVLongSlowTa5d6ff"

Tff7b72else Tff7b72-Tff7b72> Ta5d6ff"Ta5d6ffInvalidTa5d6ff"

Tb4b4b4} Tff7b72else Ta5d6ff"Ta5d6ffCustomTa5d6ff"

Tb4b4b4}

Tff7b72val Te6edf3pskTb4b4b4: Te6edf3ByteString

Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72= Tff7b72if Tb4b4b4(Te6edf3settingsTb4b4b4.Te6edf3pskTb4b4b4.Te6edf3sizeTb4b4b4(Tb4b4b4) Tff7b72!Tff7b72= T79c0ff1Tb4b4b4) Tb4b4b4{

Te6edf3settingsTb4b4b4.Te6edf3psk T8b949e// A standard PSK

Tb4b4b4} Tff7b72else Tb4b4b4{

T8b949e// One of our special 1 byte PSKs, see mesh.proto for docs.

Tff7b72val Te6edf3pskIndex Tff7b72= Te6edf3settingsTb4b4b4.Te6edf3pskTb4b4b4.Te6edf3byteAtTb4b4b4(T79c0ff0Tb4b4b4)Tb4b4b4.Te6edf3toIntTb4b4b4(Tb4b4b4)

Tff7b72if Tb4b4b4(Te6edf3pskIndex Tff7b72=Tff7b72= T79c0ff0Tb4b4b4) Tb4b4b4{

Te6edf3cleartextPSK

Tb4b4b4} Tff7b72else Tb4b4b4{

T8b949e// Treat an index of 1 as the old channelDefaultKey and work up from there

Tff7b72val Te6edf3bytes Tff7b72= Te6edf3channelDefaultKeyTb4b4b4.Te6edf3cloneTb4b4b4(Tb4b4b4)

Te6edf3bytesTff7b72[Te6edf3bytesTb4b4b4.Te6edf3size Tff7b72- T79c0ff1Tff7b72] Tff7b72= Tb4b4b4(T79c0ff0Te6edf3xff Te6edf3and Tb4b4b4(Te6edf3bytesTff7b72[Te6edf3bytesTb4b4b4.Te6edf3size Tff7b72- T79c0ff1Tff7b72] Tff7b72+ Te6edf3pskIndex Tff7b72- T79c0ff1Tb4b4b4)Tb4b4b4)Tb4b4b4.Te6edf3toByteTb4b4b4(Tb4b4b4)

Te6edf3ByteStringTb4b4b4.Te6edf3copyFromTb4b4b4(Te6edf3bytesTb4b4b4)

Tb4b4b4}

Tb4b4b4}

T8b949e/**

* Given a channel name and psk, return the (0 to 255) hash for that channel

*/

Tff7b72val Te6edf3hashTb4b4b4: Tffa657Int Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3xorHashTb4b4b4(Te6edf3nameTb4b4b4.Te6edf3toByteArrayTb4b4b4(Tb4b4b4)Tb4b4b4) Te6edf3xor Te6edf3xorHashTb4b4b4(Te6edf3pskTb4b4b4.Te6edf3toByteArrayTb4b4b4(Tb4b4b4)Tb4b4b4)

Tff7b72val Te6edf3channelNumTb4b4b4: Tffa657Int Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3loraConfigTb4b4b4.Te6edf3channelNumTb4b4b4(Te6edf3nameTb4b4b4)

Tff7b72val Te6edf3radioFreqTb4b4b4: Tffa657Float Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3loraConfigTb4b4b4.Te6edf3radioFreqTb4b4b4(Te6edf3channelNumTb4b4b4)

Tff7b72override Tff7b72fun Td2a8ffequalsTb4b4b4(Te6edf3otherTb4b4b4: Tffa657Any?Tb4b4b4)Tb4b4b4: Tffa657Boolean Tff7b72= Tb4b4b4(Te6edf3other Tff7b72is Te6edf3ChannelTb4b4b4)

Tff7b72&Tff7b72& Te6edf3pskTb4b4b4.Te6edf3toByteArrayTb4b4b4(Tb4b4b4) Te6edf3contentEquals Te6edf3otherTb4b4b4.Te6edf3pskTb4b4b4.Te6edf3toByteArrayTb4b4b4(Tb4b4b4)

Tff7b72&Tff7b72& Te6edf3name Tff7b72=Tff7b72= Te6edf3otherTb4b4b4.Te6edf3name

Tff7b72override Tff7b72fun Td2a8ffhashCodeTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657Int Tb4b4b4{

Tff7b72var Te6edf3result Tff7b72= Te6edf3settingsTb4b4b4.Te6edf3hashCodeTb4b4b4(Tb4b4b4)

Te6edf3result Tff7b72= T79c0ff3T79c0ff1 Tff7b72* Te6edf3result Tff7b72+ Te6edf3loraConfigTb4b4b4.Te6edf3hashCodeTb4b4b4(Tb4b4b4)

Tff7b72return Te6edf3result

Tb4b4b4}

Tb4b4b4}